Activities
latest
false
- Overview
- UI Automation
- UI-ANA-016 - Pull Open Browser URL
- UI-ANA-017 - ContinueOnError True
- UI-ANA-018 - List OCR/Image Activities
- UI-DBP-006 - Container Usage
- UI-DBP-013 - Excel Automation Misuse
- UI-DBP-030 - Forbidden Variables Usage In Selectors
- ST-DBP-021 - Hardcoded Timeout
- UI-PRR-001 - Simulate Click
- UI-PRR-002 - Simulate Type
- UI-PRR-003 - Open Application Misuse
- UI-PRR-004 - Hardcoded Delays
- UI-REL-001 - Large Idx in Selectors
- UI-SEC-004 - Selector Email Data
- UI-SEC-010 - App/Url Restrictions
- UI-USG-011 - Non Allowed Attributes
- SY-USG-013 - Private File Invoke
- SY-USG-014 - Incorrect Execution Template Placeholders
- Applications and technologies automated with UI Automation
- UiPath Browser Migration Tool
- Computer Vision Recorder
- Click
- Hover
- Type Secure Text
- Send Hotkey
- Type Into
- Check
- Select Item
- Select Multiple Items
- Get Text
- Set Text
- Activate
- Highlight
- Set Focus
- Anchor Base
- Context Aware Anchor
- Find Relative Element
- Indicate On Screen
- Element Exists
- Find Element
- Wait Element Vanish
- Find Children
- Get Ancestor
- Element Scope
- Get Attribute
- Set Clipping Region
- Get Position
- Take Screenshot
- Wait Attribute
- On Element Appear
- On Element Vanish
- Click Text
- Hover Text
- Find Text Position
- Get Full Text
- Get Visible Text
- Extract Structured Data
- Text Exists
- Click OCR Text
- Hover OCR Text
- Get OCR Text
- Find OCR Text Position
- Microsoft OCR
- Microsoft Project Oxford Online OCR
- Microsoft Azure Computer Vision OCR
- Tesseract OCR
- Google Cloud Vision OCR
- OCR Text Exists
- Click Image
- Hover Image
- Find Image Matches
- Image Exists
- Find Image
- Wait Image Vanish
- On Image Appear
- On Image Vanish
- Load Image
- Save Image
- Attach Browser
- Close Tab
- Go Back
- Go Forward
- Go Home
- Inject JS Script
- Navigate To
- Open Browser
- Refresh Browser
- Set Web Attribute
- Attach Window
- Close Window
- Get Active Window
- Hide Window
- Maximize Window
- Minimize Window
- Move Window
- Restore Window
- Show Window
- Export UI Tree
- Invoke ActiveX Method
- Inject .NET Code
- Click Trigger
- Key Press Trigger
- Click Image Trigger
- System Trigger
- Hotkey Trigger
- Mouse Trigger
- Get Event Info
- Monitor Events
- Get Source Element
- Replay User Event
- Block User Input
- Use Foreground
- Element Attribute Change Trigger
- Element State Change Trigger
- Callout
- Copy Selected Text
- Get From Clipboard
- Set To Clipboard
- Close Application
- Open Application
- Start Process
- Get Password
- Tooltip
- Click Picture on Screen
- Click Toolbar Button
- Read Statusbar
- Select Dates in Calendar
- Select Menu Item
- Expand Tree
- Call Transaction
- SAP Logon
- SAP Login
- Table Cell Scope
- SAP Session Attributes Change Trigger
- Expand ALV Tree
- Expand ALV Hierarchical Table
- Use Application/Browser
- Check App State
- Check/Uncheck
- Click
- Extract Table Data
- Get Text
- Get URL
- Go to URL
- Highlight
- Hover
- Keyboard Shortcuts
- Navigate Browser
- Select Item
- Take Screenshot
- Type Into
- Get Attribute
- Get Browser Data
- Set Browser Data
- Mouse Scroll
- Inject Js Script
- Drag and Drop
- For Each UI Element
- Application Event Trigger
- Click Event Trigger
- Keypress Event Trigger
- Set Text
- Check Element
- Fill Form
- Perform browser search and retrieve results using UI Automation APIs
- Web Browsing
- Find Images
- Click Images
- Trigger and Monitor Events
- Create and Override Files
- HTML Pages: Extract and Manipulate Information
- Window Manipulation
- Automated List Selection
- Find and Manipulate Window Elements
- Manage Text Automation
- Load and Process Images
- Manage Mouse Activated Actions
- Automate Application Runtime
- Automated Run of a Local Application
- Browser Navigation
- Web Automation
- Trigger Scope Example
- Computer Vision Local Server
- Mobile Automation
- Release notes
- Project compatibility
- Get Log Types
- Get Logs
- Get Page Source
- Get Device Orientation
- Get Session Identifier
- Install App
- Manage Current App
- Manage Other App
- Open DeepLink
- Open URL
- Mobile Device Connection
- Positional Swipe
- Press Hardware Button
- Set Device Orientation
- Take Screenshot
- Take Screenshot Part
- Element Exists
- Execute Command
- Get Attribute
- Get Selected Item
- Get Text
- Set Selected Item
- Set Text
- Swipe
- Tap
- Type Text
- Draw Pattern
- Terminal
UI Automation Activities
Last updated Apr 26, 2024
Attach
Focuses on a desktop application or web browser page that's already open, to use in UI automation.
This API is used by calling the UIAutomation service, based on the following format:
uiAutomation.<APIMethod>()
. For example,
uiAutomation.Open()
.
Namespace: UiPath.UIAutomationNext.API.Contracts
Assembly: UiPath.UIAutomationNext.API.Contracts (in UiPath.UIAutomationNext.API.Contracts dll)
Overload | Description |
---|---|
Attach(String, TargetAppOptions, String,
String) | Focuses on a specific desktop application or web page to use in UI automation, identified by the screen name from the Object Repository. |
Attach(TargetAppModel, TargetAppOptions) | Focuses on a specific desktop application or web page to use in
UI automation, identified by the TargetAppModel
object.
|
Attach(String, String, String, NAppAttachMode,
NWindowResize, NInteractionMode) | Focuses on a specific desktop application or web page to use in UI automation, identified by the screen name from the Object Repository, along with other customizations of the app or web page. |
Focuses on a specific desktop application or web page to use in UI automation, identified by the screen name from the Object Repository.
Attach(
string screenName,
TargetAppOptions targetAppOptions,
[string appName],
[string appVersion])
Attach(
string screenName,
TargetAppOptions targetAppOptions,
[string appName],
[string appVersion])
screeName
String- The name of the screen you want to focus on, as a String recorded inside the Object Repository.
targetAppOptions
TargetAppOptions
- Additional options and settings for attaching to the application or web
page:
Timeout Double
- Specify a number of seconds for which to wait for the activity to be executed before throwing an error. The default value is 30 seconds. When indicating a window in a Remote Desktop environment, the Timeout default setting is set to 60 seconds.InteractionMode NInteractionMode
:HardwareEvents
- Uses the hardware driver to perform the action. This is the slowest API, it cannot work in the background, but it is compatible with all desktop apps.Simulate
- Simulates the action using accessibility APIs. Recommended in browser automation, Java apps, or SAP. More reliable than Hardware Events. Sends all text in a single action. Works even if the target application is not in focus. Please test if your target application UI element supports this.DebuggerApi
- Performs actions using debugger APIs. Works only for Chromium elements. Sends all text in one go. Works even if target app is not in focus. For more details, check out this page.WindowMessages
- Sends the mouse and keyboard input through Win32 messages. Recommended for desktop apps. Usually more reliable than Hardware Events. Sends all text in a single action. Works even if target app is not in focus. Please test if your target application UI element supports this.Background
- Runs actions in the background. Tries to use either Simulate or Chromium API where possible, while complex APIs (image, native text) run as usual, in the foreground. It is highly recommended to use this API with the Verify Execution feature.
OpenMode NAppOpenMode
- choose when to open the app:Never
(never open the application)IfNotOpen
(open only if the application is closed, this is the default selection, only works ifFilePath
orURL
are provided)Always
(open another instance of the application even if one is already open, only works ifFilePath
orURL
are provided)
WindowResize NWindowResize
- choose the size of the window:None
Maximize
Restore
Minimize
UserDataFolderMode BrowserUserDataFolderMode
- TheUserDataFolderMode
you want to set. It is used to start the browser with a specific user data folder.Automatic
- Picture In Picture mode uses a different folder than the default mode, automatically generated ifUserDataFolderPath
is not set.DefaultFolder
- Uses the default browser folder, no matter if it runs in the main or PIP session.CustomFolder
- Uses the folder specified inUserDataFolderPath
or an auto generated path ifUserDataFolderPath
is not set.
UserDataFolderPath String
- The user data folder that the browser uses. Defaults to%LocalAppData%\UiPath\PIP Browser Profiles\BrowserType
if not set.IsIncognito Boolean
- inputTrue
if you want to open the browser in incognito mode. By default it's set toFalse
.WebDriverMode NWebDriverMode
- Indicates how the WebDriver is used when opening a new browser session. The following options are available:Disabled
- Disables the use of WebDriver.WithGUI
- The GUI of the browser is displayed.Headless
- The browser is launched silently, with no GUI.
appName
String- The name of the application to attach to. This parameter is applicable for desktop applications.
appVersion
String- The version of the application to attach to. This parameter is applicable for desktop applications.
Focuses on a specific desktop application or web page to use in UI automation,
identified by the
TargetAppModel
object.
Attach(
TargetAppModel targetApp,
[TargetAppOptions targetAppOptions]))
Attach(
TargetAppModel targetApp,
[TargetAppOptions targetAppOptions]))
targetApp
TargetAppModel
- The target application or web page to attach to. It is an object of type
TargetAppModel
that provides information about the application:Selector String
- An XML fragment that stores the attributes of a user interface element.FilePath String
- If the application is not a web browser, specifies the full path of the executable file to open.Arguments String
- If the application is not a web browser, you can specify parameters to pass to the target application at startup.Url String
- If the application is a web browser, specifies the URL of the web page to open.Title String
- The title of the application or browser.
targetAppOptions
TargetAppOptions
- Additional options and settings for attaching to the application or web
page:
Timeout Double
- Specify a number of seconds for which to wait for the activity to be executed before throwing an error. The default value is 30 seconds. When indicating a window in a Remote Desktop environment, the Timeout default setting is set to 60 seconds.InteractionMode NInteractionMode
:HardwareEvents
- Uses the hardware driver to perform the action. This is the slowest API, it cannot work in the background, but it is compatible with all desktop apps.Simulate
- Simulates the action using accessibility APIs. Recommended in browser automation, Java apps, or SAP. More reliable than Hardware Events. Sends all text in a single action. Works even if the target application is not in focus. Please test if your target application UI element supports this.DebuggerApi
- Performs actions using debugger APIs. Works only for Chromium elements. Sends all text in one go. Works even if target app is not in focus. For more details, check out this page.WindowMessages
- Sends the mouse and keyboard input through Win32 messages. Recommended for desktop apps. Usually more reliable than Hardware Events. Sends all text in a single action. Works even if target app is not in focus. Please test if your target application UI element supports this.Background
- Runs actions in the background. Tries to use either Simulate or Chromium API where possible, while complex APIs (image, native text) run as usual, in the foreground. It is highly recommended to use this API with the Verify Execution feature.
OpenMode NAppOpenMode
- choose when to open the app:Never
(never open the application)IfNotOpen
(open only if the application is closed, this is the default selection, only works ifFilePath
orURL
are provided)Always
(open another instance of the application even if one is already open, only works ifFilePath
orURL
are provided)
WindowResize NWindowResize
- choose the size of the window:None
Maximize
Restore
Minimize
UserDataFolderMode BrowserUserDataFolderMode
- TheUserDataFolderMode
you want to set. It is used to start the browser with a specific user data folder.Automatic
- Picture In Picture mode uses a different folder than the default mode, automatically generated ifUserDataFolderPath
is not set.DefaultFolder
- Uses the default browser folder, no matter if it runs in the main or PIP session.CustomFolder
- Uses the folder specified inUserDataFolderPath
or an auto generated path ifUserDataFolderPath
is not set.
UserDataFolderPath String
- The user data folder that the browser uses. Defaults to%LocalAppData%\UiPath\PIP Browser Profiles\BrowserType
if not set.IsIncognito Boolean
- inputTrue
if you want to open the browser in incognito mode. By default it's set toFalse
.WebDriverMode NWebDriverMode
- Indicates how the WebDriver is used when opening a new browser session. The following options are available:Disabled
- Disables the use of WebDriver.WithGUI
- The GUI of the browser is displayed.Headless
- The browser is launched silently, with no GUI.
Focuses on a specific desktop application or web page to use in UI automation, identified by the screen name from the Object Repository, along with other customizations of the app or web page.
Attach(string screenName,
[string appName],
[string appVersion],
[NAppAttachMode appAttachMode],
[NWindowResize windowResize],
[NInteractionMode interactionMode]))
Attach(string screenName,
[string appName],
[string appVersion],
[NAppAttachMode appAttachMode],
[NWindowResize windowResize],
[NInteractionMode interactionMode]))
screeName
String- The name of the screen you want to focus on, as a String recorded inside the Object Repository.
appName
String- The name of the application to attach to. This parameter is applicable for desktop applications.
appVersion
String- The version of the application to attach to. This parameter is applicable for desktop applications.
appAttachMode
NAppAttachMode
-
ByProcessName
- Further APIs will search in all windows with the same process name as the indicated app.ByInstance
- Further APIs will search in the indicated application instance, including all parent and child windows (alerts, popups, etc.). Other instances of the application are excluded.SingleWindow
- Further APIs will search only in the indicated window.
windowResize
NWindowResize
- Choose the size of the window:
None
Maximize
Restore
Minimize
interactionMode
NInteractionMode
- Choose which API the Robot should use to interact with the target
application:
HardwareEvents
- Uses the hardware driver to perform the action. This is the slowest API, it cannot work in the background, but it is compatible with all desktop apps.Simulate
- Simulates the action using accessibility APIs. Recommended in browser automation, Java apps, or SAP. More reliable than Hardware Events. Sends all text in a single action. Works even if the target application is not in focus. Please test if your target application UI element supports this.DebuggerApi
- Performs actions using debugger APIs. Works only for Chromium elements. Sends all text in one go. Works even if target app is not in focus. For more details, check out this page.WindowMessages
- Sends the mouse and keyboard input through Win32 messages. Recommended for desktop apps. Usually more reliable than Hardware Events. Sends all text in a single action. Works even if target app is not in focus. Please test if your target application UI element supports this.Background
- Runs actions in the background. Tries to use either Simulate or Chromium API where possible, while complex APIs (image, native text) run as usual, in the foreground. It is highly recommended to use this API with the Verify Execution feature.